Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AYON USD Docs and Add AYON USD Resolver Docs #238

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

MustafaJafar
Copy link
Contributor

@MustafaJafar MustafaJafar commented Sep 11, 2024

Changelog Description

This PR:

  • update header section in all USD pages.
  • Add USD resolver docs for admins,
    • Enable resolver and lakefs settings
    • Enable using entity URIs when exporting and loading
    • Note about Pinning support
    • References
  • Add USD resolver docs for artists which explains
    • the structure of the URI
    • pinning support.
  • Refine docs

Testing notes:

Read through and let us know what do you think.

@Lypsolon
Copy link

im not a 100% sure what i should do here ?
if some one could give me a short that needs to be done or provide this that would be great.

@MustafaJafar
Copy link
Contributor Author

im not a 100% sure what i should do here ? if some one could give me a short that needs to be done or provide this that would be great.

I made this PR based on a discussion with @BigRoy where we agreed on creating two pages for USD Asset Resolver one for artists and one for admins.

Feel free to push any commits to this PR, maybe we can discuss with BigRoy about what sections should be added.

@Lypsolon
Copy link

im not a 100% sure what i should do here ? if some one could give me a short that needs to be done or provide this that would be great.

I made this PR based on a discussion with @BigRoy where we agreed on creating two pages for USD Asset Resolver one for artists and one for admins.

Feel free to push any commits to this PR, maybe we can discuss with BigRoy about what sections should be added.

ah thanks for the info.
@BigRoy im just a bit confused: wasn't the content of the talk that we need admin and developer docs for the resolver as the artists kinda dont need to know about it ?

@MustafaJafar
Copy link
Contributor Author

MustafaJafar commented Sep 12, 2024

ah thanks for the info. @BigRoy im just a bit confused: wasn't the content of the talk that we need admin and developer docs for the resolver as the artists kinda dont need to know about it ?

It's also worth mentioning that APIs and resources are added in a dedicated PR #239

for the mentioned PR, I think it's fair to add a very basic short info about the USD resolver then we can create a follow up PR to enhance it.

@mkolar
Copy link
Member

mkolar commented Sep 12, 2024

I agree that unless we have something to say, the artist resolver docs are not needed and more confusing than helping. the rest is fine

@MustafaJafar MustafaJafar marked this pull request as draft September 12, 2024 21:29
@MustafaJafar
Copy link
Contributor Author

Marking this PR as draft since it's in progress.

(large) renderfarms to avoid the many resolves and server queries degrading
the server's performance.

**TODO** Explain how the pinning works technically and what env vars will be set to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@antirotor This I suppose would be in your hands. These are the admin facing docs.

Copy link

@Lypsolon Lypsolon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the few small thoughts I gave, I believe this is good to go.

---

Automatically contribute products into USD assets or shots

:::info

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should rather say that the Ayon contribution workflow was introduced around this time or its version, not this pr.

Reason:
many commits Created the Contribution workflow.
It might be confusing if you look at this one PR and don't see all the parts that made the contribution workflow.

website/docs/addon_usd_resolver_admin.md Outdated Show resolved Hide resolved
```
ayon+settings://maya/load/MayaUsdLoader/use_ayon_entity_uri
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add where you need to add the LakeFs keys?

### AyonUsd 
ayon+settings://ayon_usd/lakefs/access_key_id
ayon+settings://ayon_usd/lakefs/secret_access_key


:::

## Caching

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a point to mention that we don't do this for Deduplicaiont (Usd already does this internally) and also that the Cache is not bound to the Resolver class instance (If not explicitly requested via API) but lives as an instance shared cache.

I mention this because I talked about just that on the Usd forums, and it caused a bit of confusion before I explained it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants